home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsISimpleEnumerator.idl < prev    next >
Text File  |  2006-05-08  |  3KB  |  82 lines
  1. /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 1998
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *
  24.  * Alternatively, the contents of this file may be used under the terms of
  25.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27.  * in which case the provisions of the GPL or the LGPL are applicable instead
  28.  * of those above. If you wish to allow use of your version of this file only
  29.  * under the terms of either the GPL or the LGPL, and not to allow others to
  30.  * use your version of this file under the terms of the MPL, indicate your
  31.  * decision by deleting the provisions above and replace them with the notice
  32.  * and other provisions required by the GPL or the LGPL. If you do not delete
  33.  * the provisions above, a recipient may use your version of this file under
  34.  * the terms of any one of the MPL, the GPL or the LGPL.
  35.  *
  36.  * ***** END LICENSE BLOCK ***** */
  37.  
  38. #include "nsISupports.idl"
  39.  
  40. /**
  41.  * Used to enumerate over elements defined by its implementor.
  42.  * Although hasMoreElements() can be called independently of getNext(),
  43.  * getNext() must be pre-ceeded by a call to hasMoreElements(). There is
  44.  * no way to "reset" an enumerator, once you obtain one.
  45.  *
  46.  * @status FROZEN
  47.  * @version 1.0
  48.  */
  49.  
  50. [scriptable, uuid(D1899240-F9D2-11D2-BDD6-000064657374)]
  51. interface nsISimpleEnumerator : nsISupports {
  52.   /**
  53.    * Called to determine whether or not the enumerator has
  54.    * any elements that can be returned via getNext(). This method
  55.    * is generally used to determine whether or not to initiate or
  56.    * continue iteration over the enumerator, though it can be
  57.    * called without subsequent getNext() calls. Does not affect
  58.    * internal state of enumerator.
  59.    *
  60.    * @see getNext()
  61.    * @return PR_TRUE if there are remaining elements in the enumerator.
  62.    *         PR_FALSE if there are no more elements in the enumerator.
  63.    */                                            
  64.   boolean hasMoreElements();
  65.  
  66.   /**
  67.    * Called to retrieve the next element in the enumerator. The "next"
  68.    * element is the first element upon the first call. Must be
  69.    * pre-ceeded by a call to hasMoreElements() which returns PR_TRUE.
  70.    * This method is generally called within a loop to iterate over
  71.    * the elements in the enumerator.
  72.    *
  73.    * @see hasMoreElements()
  74.    * @return NS_OK if the call succeeded in returning a non-null
  75.    *               value through the out parameter.
  76.    *         NS_ERROR_FAILURE if there are no more elements
  77.    *                          to enumerate.
  78.    * @return the next element in the enumeration.
  79.    */
  80.   nsISupports getNext();
  81. };
  82.